.. _`Confusion Matrix`:

.. _`org.sysess.sympathy.machinelearning.confusion`:

Confusion Matrix
~~~~~~~~~~~~~~~~

.. image:: confusion_matrix.svg
   :width: 48


Computes the confusion matrix given predictions and true Y-values.



**Documentation**

Computes the confusion matrix given predictions and true Y-values.

*Configuration*:


  - *labels*

    List of labels to index the matrix. This may be used to reorder
    or select a subset of labels.
    If ``None`` is given, those that appear at least once
    in ``y_true`` or ``y_pred`` are used in sorted order.


  - *include heading*

    Adds a columns with used class names



*Attributes*:




*Input ports*:
    **Y-pred** : table
        Y-pred
    **Y-true** : table
        Y-true

*Output ports*:
    **confusion-matrix** : table
        confusion-matrix


**Definition**


*Input ports*

    :Y-pred:  table

        Y-pred

    :Y-true:  table

        Y-true


*Output ports*

    :confusion-matrix:  table

        confusion-matrix





.. automodule:: node_metrics
    :noindex:

.. class:: ConfusionFromPrediction
    :noindex: